home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / os2bbs / qfb107.zip / QFB.DOC < prev    next >
Text File  |  1996-02-29  |  14KB  |  326 lines
  1.                 
  2.         **************************************************************
  3.         *                                                            *
  4.         *                                                            *
  5.         *                   *****   *******  ******                  *
  6.         *                  **   **   **   *   **  **                 *
  7.         *                  **   **   ** *     **  **                 *
  8.         *                  **   **   ****     *****                  *
  9.         *                  **   **   ** *     **  **                 *
  10.         *                  **   **   **       **  **                 *
  11.         *                   ***** * ****     ******                  *
  12.         *                                                            *
  13.         *                                                            *
  14.         *                  A Quick File Base Builder                 *
  15.         *                 v 1.07 for Maximus 3.xx (*)                *
  16.         *                                                            *
  17.         **************************************************************
  18.         *                                                            *
  19.         *         (C) Copyright 1995-1996 by Alberto Pasquale        *
  20.         *                                                            *
  21.         *            A L L   R I G H T S   R E S E R V E D           *
  22.         *                                                            *
  23.         *                    F R E E W A R E                         *
  24.         *                                                            *
  25.         **************************************************************
  26.         
  27.         * Maximus is a trademark of Lanius Corporation
  28.         
  29.  
  30.                   (c) Copyright 1995-1996 by Alberto Pasquale
  31.         
  32.                                 F R E E W A R E
  33.         
  34.         
  35.                 
  36.                                     LICENSE
  37.         
  38.         
  39.         You may copy, distribute and use this program freely, provided
  40.         you do not modify the original archive and Copyrights.
  41.         
  42.         
  43.         
  44.                 
  45.                                    DISCLAIMER
  46.         
  47.         You are entitled to use this freeware program "as is". No
  48.         guarantee can be given on the performance of the program. The
  49.         author will not be liable for any damage or loss related to the
  50.         use of this program.
  51.         
  52.         
  53.         
  54.                 
  55.                                     Overview
  56.         
  57.         
  58.         QFB is a substitute for the FB (Dos) or FBP (OS/2) program by
  59.         Scott J. Dudley for building a Maximus 3.xx file-base (Maximus
  60.         is a trademark of Lanius Corporation).
  61.         
  62.         Main characteristics:
  63.         
  64.         - Generates UniFiles.Idx in addition to the standard
  65.           MaxFiles.Idx; UniFiles.Idx is an index file like MaxFiles.Idx
  66.           but with no duplicates (in the case of dupes, the file in the
  67.           first defined area is kept in the index).
  68.         
  69.           You can use UniFiles.Idx as a file-request index for your
  70.           mailer (e.g. BinkleyTerm (c) Bit Bucket Software)
  71.         
  72.         - Support for multi-line descriptions.
  73.         
  74.           Usually the description of a file in the FILES.BBS is
  75.           contained in a single physical line: Maximus will word wrap
  76.           and align when displaying it to the user.
  77.         
  78.           The problems come when you import the multi-line file_id.diz
  79.           descriptions into the FILES.BBS in order to make Maximus show
  80.           them to the user keeping the original formatting.
  81.         
  82.           As a matter of facts, Maximus (partially) supports
  83.           "continuation" lines that begin with '|' or '+' (second or
  84.           greater column). However many people like using NO
  85.           continuation character: they add multi-line descriptions one
  86.           line after another, indenting the subsequent lines so that
  87.           Maximus shows them aligned (but it does not recognize them in
  88.           the case of hurl, kill etc.). File management programs are
  89.           then used to correctly manage the areas.
  90.         
  91.           QFB supports a user-defined continuation character and
  92.           position, which default to the space ' ' and 31 (columns)
  93.           respectively (see the -c command line switch).
  94.         
  95.           QFB adds continuation lines to the FILES.DMP without loosing
  96.           formatting. You can verify this by using the L)ocate or
  97.           N)ewfiles command of Maximus. FB/FBP, on the contrary,
  98.           concatenate all the lines together (when they area recognized
  99.           as continuation lines...).
  100.         
  101.           There is a side effect, though: The L)ocate and N)ewfiles
  102.           commands show the continuation lines aligned at left.
  103.           Since this behaviour is not appreciated by some SysOps, the
  104.           "-d" command line switch allows to output a unique-line
  105.           description to FILES.DMP: original formatting is lost (as with
  106.           FB/FBP) but the entire description is word-wrapped and aligned
  107.           by Maximus.
  108.         
  109.         - Very fast update operation (when a list of areas is specified
  110.           on the command line or the -n switch is used).
  111.         
  112.         - Fast operation even in the full-build.
  113.         
  114.         - The -n switch allows to update the filebase by compiling only
  115.           modified areas, even if you do not have a list of area names
  116.           available.
  117.         
  118.         - Area names can be specified using the '?' and '*' wildcards as
  119.           per the OS/2 rules. E.G. "*OS2*" includes all areas whose name
  120.           contains "OS2".
  121.         
  122.         - Can be used with CD-ROMs with no need to copy the FILES.BBS to
  123.           a hard-disk directory, provided you don't really need the
  124.           DAT/DMP/IDX files for the area: the global indexes
  125.           (MaxFiles.Idx and UniFiles.Idx) will contain the data for
  126.           these areas so that File-Request, Global Download and Upload
  127.           Dupe Check will work anyway.
  128.         
  129.         - Does not abort nor prompt user in the case of "drive not
  130.           ready" or "write protected" errors.
  131.         
  132.         - Retries for many seconds in case of a sharing violation.
  133.           Please note that in the case of protracted inability to open a
  134.           DAT/DMP/IDX file for write, QFB could report a "Write
  135.           Protected" area instead of the sharing violation. It will
  136.           proceed anyway as if the unit were write protected.
  137.         
  138.         - All ApWorks programs that access the FileBase use a
  139.           "FileBase.Bsy" flag in the Maximus system directory to avoid
  140.           concurrent writes to the same filebase. There is no problem in
  141.           the case the FileBase.Bsy flag is not deleted due to abnormal
  142.           terminations or power failures, so you do not need to delete
  143.           it in the startup.cmd/autoexec.bat as with other programs.
  144.         
  145.         
  146.         
  147.         
  148.                 
  149.                                          Usage
  150.         
  151.         
  152.         The command line parameters are the same as with FB/FBP, with a
  153.         few exceptions:
  154.         
  155.         QFB [<switches>] [<area> ...]
  156.         
  157.         If no command line parameter is given, the help is shown. If no
  158.         <area> is given and the -n switch is not used, all areas are
  159.         compiled.
  160.         
  161.         
  162.          -a
  163.                 Compile all areas.
  164.         
  165.                 This is the default, but the switch is needed when no
  166.                 other switches are used (QFB shows help on an empty
  167.                 command).
  168.         
  169.         
  170.          -c[<nn>[<c>|#<nnn>]]
  171.         
  172.                 The default for continuation column/character is 31/' '.
  173.                 That is, if a line that starts with 31 spaces is found
  174.                 after a description line in the FILES.BBS, then it is
  175.                 taken as a continuation line. Empty lines are also taken
  176.                 as continuation lines, in order to allow correct
  177.                 processing of file_id.diz descriptions that contain
  178.                 blank lines.
  179.         
  180.                 You can disable multi-line description support by using
  181.                 "-c" alone.
  182.         
  183.                 e.g.  -c   (disables multi-line support)
  184.         
  185.                 You can override the number of blank columns required by
  186.                 using "-c<nn>" where <nn> specifies the number of spaces
  187.                 needed at the start of a line to consider it a
  188.                 continuation line.
  189.         
  190.                 e.g. -c34  (34 spaces required)
  191.         
  192.                 If you want to use some special character (not the
  193.                 simple space) as a continuation character, then you must
  194.                 specify it in the -c switch after the <nn>. You can
  195.                 either specify the character directly (<c>) or by its
  196.                 ASCII code (#<nnn>). Please note that the '|'
  197.                 (frequently used) is the symbol for pipe, so it CANNOT
  198.                 be used on a command line: you must either specify its
  199.                 ASCII code or prefix it with an escape character.
  200.         
  201.                 e.g. -c29+     (the continuation lines start with '+')
  202.                      -c29#124  (124 is the ASCII code for '|')
  203.                      -c29^|    (OS/2 escape sequence for '|')
  204.         
  205.                 Since the continuation lines usually have a space after
  206.                 the continuation character, QFB skips it if present.
  207.         
  208.                 Example:
  209.         
  210.                 TEST.ZIP  This is a long description
  211.                                  | for the file test.zip
  212.                                  |
  213.                                  | Author: <author>
  214.                                  | Shareware US$30
  215.         
  216.                 Note: the <nn> number of spaces is essential when the
  217.                       continuation character is not specified (simple
  218.                       space). On the contrary, it is not currently
  219.                       really meaningful when the continuation character
  220.                       is different from space (the only difference is
  221.                       between 0 and >0).
  222.         
  223.                       For example, if you use "-c29#124", QFB accepts as
  224.                       continuation lines all those whose first non-space
  225.                       character is '|', provided it is NOT in the first
  226.                       column. To make QFB accept a continuation
  227.                       character in the first column you must specify 0
  228.                       as <nn> ("-c00#124").
  229.         
  230.         
  231.          -d
  232.                Output Unique-Line descriptions to FILES.DMP.
  233.         
  234.                Avoids multi-line descriptions in FILES.DMP, the file
  235.                where Maximus looks for the file descriptions when using
  236.                the filebase (L)ocate and N)ewfiles commands).
  237.         
  238.                When multi-line description support is used, QFB outputs
  239.                the entire description string (line feeds included) to
  240.                the FILES.DMP, so that the Maximus L)ocate and N)ewfiles
  241.                commands respect the original formatting.
  242.         
  243.                Unfortunately there is a side-effect: the continuation
  244.                lines are aligned at left, and this is not appreciated by
  245.                some SysOps.
  246.         
  247.                When this switch is used, QFB changes the linefeeds to
  248.                spaces, so that the DMP description is made of a long
  249.                unique line: the original formatting is lost but the
  250.                description will be aligned and word-wrapped by Maximus
  251.                when the L)ocate or N)ewfiles commands are used.
  252.         
  253.         
  254.          -f<file>
  255.                 Use <file> as farea.dat.
  256.         
  257.                 This overrides the information from Max.Prm.
  258.         
  259.         
  260.          -g
  261.                 Compile global index only.
  262.         
  263.                 The DAT/DMP/IDX files of each area are not generated.
  264.         
  265.                 Do not use this switch if you are not really sure you do
  266.                 not need these files.
  267.         
  268.         
  269.          -n
  270.                 Compile areas with new Files.Bbs.
  271.         
  272.                 All areas that have a Files.Bbs newer than the Files.Idx
  273.                 will be compiled and the MaxFiles/UniFiles.idx updated;
  274.                 areas marked as "Type CD" are skipped.
  275.         
  276.                 This switch is meaningless when the -g switch has been
  277.                 used (files.idx not generated).
  278.         
  279.         
  280.          -p<file>
  281.                 Use <file> as the Maximus .prm file.
  282.         
  283.                 Overrides the MAXIMUS environment var.
  284.                 The .prm extension is added if no extension is given.
  285.         
  286.         
  287.          -s
  288.                 Skip slow areas marked as "Type CD".
  289.         
  290.         
  291.          -u
  292.                 Scan upload paths.
  293.         
  294.                 This switch is used by Maximus in RunFB.Cmd (.Bat for
  295.                 DOS) when the update of upload areas is needed.
  296.         
  297.                 The Upload paths for the listed areas are scanned
  298.                 instead of the download ones, provided the upload path
  299.                 is in a defined Maximus area.
  300.         
  301.         
  302.         <area> can include wildcards ('?', '*') in the OS/2 way.
  303.         
  304.         
  305.         Errorlevels:
  306.         
  307.         
  308.         7 Out of memory
  309.         6 Timeout waiting for a busy FileBase
  310.         5 FArea.Dat not found
  311.         4 Max.Prm not found: either MAXIMUS environment variable or
  312.           -p<file> command line switch must point to a valid Max 3.xx
  313.           PRM file.
  314.         3 Abnormal termination
  315.         2 Error
  316.         1 Help requested
  317.         0 OK
  318.         
  319.         
  320.         IMPORTANT NOTE for the Dos version:
  321.                 QFB is a 32 bit application: it requires the Dos4GW.Exe
  322.                 dos extender in your path.
  323.         
  324.         
  325.         
  326.